fix(editor): rename reserved keyword methods in MarkdownManager#21
Open
alyssonbarrera wants to merge 1 commit into
Open
fix(editor): rename reserved keyword methods in MarkdownManager#21alyssonbarrera wants to merge 1 commit into
alyssonbarrera wants to merge 1 commit into
Conversation
`export` and `import` are reserved JavaScript keywords. Using them as method names in a class causes a SyntaxError in Safari when Vite pre-bundles the file with esbuild, because esbuild keeps the literal method names and Safari's parser rejects them. Rename `MarkdownManager#export` → `toMarkdown` and `MarkdownManager#import` → `fromMarkdown` to fix cross-browser compatibility without changing any public API. Fixes novincode#20
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
MarkdownManagerusesexportandimportas method names. These are reserved JavaScript keywords. When Vite pre-bundles@lexkit/editorwith esbuild, the method names are kept literally in the output. Safari's parser rejects this with:This makes the library unusable in Safari when consumed via Vite.
Fixes #20
Fix
Rename the two private methods on
MarkdownManager:export()→toMarkdown()import()→fromMarkdown()The public API (
exportToMarkdownandimportFromMarkdowncommands exposed viagetCommands) is unchanged.Demo
Without fix - Safari throws SyntaxError, editor fails to load:
error-demonstration.mov
With fix - editor loads and works correctly in Safari:
success-demonstration.mov
Testing
pnpm --filter @lexkit/editor test)export()/.import(before fixapps/web(Next.js) withpnpm --filter web dev- no regressions